Vcenter Ovf OvfError

Vcenter Ovf OvfError
Vcenter Ovf OvfError

The Vcenter Ovf OvfError schema describes an error related to accessing, validating, deploying, or exporting an OVF package.

JSON Example
{
    "category": "string",
    "issues": [
        {
            "category": "string",
            "file": "string",
            "line_number": 0,
            "column_number": 0,
            "message": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        }
    ],
    "name": "string",
    "value": "string",
    "message": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "error": {
        "messages": [
            {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        ],
        "data": {},
        "error_type": "string"
    }
}
string
category
Required

The message category.

For more information see: Vcenter Ovf OvfMessage Category.

issues
Optional

List of parse issues (see Vcenter Ovf ParseIssue).

This property is optional and it is only relevant when the value of category is Vcenter Ovf OvfMessage Category.VALIDATION.

string
name
Optional

The name of input parameter.

This property is optional and it is only relevant when the value of category is Vcenter Ovf OvfMessage Category.INPUT.

string
value
Optional

The value of input parameter.

This property is optional and it is only relevant when the value of category is Vcenter Ovf OvfMessage Category.INPUT.

message
Optional

A localizable message.

This property is optional and it is only relevant when the value of category is Vcenter Ovf OvfMessage Category.INPUT.

error
Optional

The Vapi Std Errors Error error describes theproperties common to all standard errors.

This error serves two purposes:

  1. It is the error that clients in many programming languages can catch to handle all standard errors. Typically those clients will display one or more of the localizable messages from Vapi Std Errors Error.messages to a human.
  2. It is the error that operations can report when they need to report some error, but the error doesn't fit into any other standard error, and in fact the only reasonable way for a client to react to the error is to display the message(s) to a human.